Skip to content

Add wasm32 support to the rust sdk #2704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Add wasm32 support to the rust sdk #2704

wants to merge 13 commits into from

Conversation

thlsrms
Copy link

@thlsrms thlsrms commented May 5, 2025 •
edited
Loading

Description of Changes

Enabled the Rust SDK wasm32 compilation target for web usage.

  • Users targeting wasm32-unknown-unknown must set: RUSTFLAGS='--cfg getrandom_backend="wasm_js"' to enable getrandom's webassembly support.
  • Added web feature flag, incompatible with non-wasm32 targets.

API and ABI breaking changes

None. Most changes apply only to the wasm32 target, so there are no global breaking changes. The main differences to the native targets are:

  • DBConnectionBuilder::build is now async on the web.
  • Authorization token is sent as a query parameter instead of in a header.
  • Credentials handling:
    • File struct unavailable on the web.
    • Two browser-friendly options are provided:
      • The re-exported API from gloo_storage for local/session storage.
      • A Cookie builder to manage cookies (except HttpOnly cookies).

Expected complexity level and risk

Estimated at 2:

  • Most work involves adjusting dependencies and feature flags.
  • Non-blocking alternatives replace a few native SDK code paths.

Opening this PR as a draft to get comments on it.

Testing

I built 2 demos to exercise the changes:

  1. Bevy https://github.com/thlsrms/tictactoe-stdb-bevy
  2. Leptos https://github.com/thlsrms/stdb-leptos-quickstart

Note: No automated tests have been written yet.

@CLAassistant
Copy link

CLAassistant commented May 5, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@akaia-shadowfox akaia-shadowfox mentioned this pull request May 14, 2025
Open
@bfops
Copy link
Collaborator

bfops commented May 27, 2025

@thlsrms Thank you for opening this! What's the current status? Are there parts still in progress, or should we be getting a reviewer on this?

@thlsrms
Copy link
Author

thlsrms commented May 27, 2025

@thlsrms Thank you for opening this! What's the current status? Are there parts still in progress, or should we be getting a reviewer on this?

I've been working on support for the wasm32-unknown-emscripten target on this branch: https://github.com/thlsrms/SpacetimeDB/blob/rust-emscripten-sdk/crates/sdk/src/emscripten.rs, with the intention of including it in this PR. While it's functional on Chromium, Firefox requires further effort.

To keep this PR focused, I'll defer the emscripten support to a separate PR if necessary.

I'll make some minor adjustments and rebase onto master. I'll ping you tomorrow if that's alright.

@bfops
Copy link
Collaborator

bfops commented May 27, 2025

@thlsrms absolutely, thank you!

and no rush. I'm going to be out of office Wed-Fri this week, but either way it might take a little while for us to get around to reviewing, since we have some other things in progress right now.

thlsrms added 13 commits May 28, 2025 22:54
@thlsrms
Replace SDK File struct with StorageEntry for web
53e30c2
@thlsrms
Enable web build for the SDK crate
72cb469 
- `DbConnectionBuilder::build` becomes async without tokio's
block_in_place.

Still need to add `web` feature flag.
@thlsrms
Enable run_threaded on the web with spawn_local
b1ace44
@thlsrms
Replace anymap with anymap3
439cc8c 
Replaces the unmaintained `anymap` dependency to fix a panic caused by
`copy_nonoverlapping::precondition_check` due to alignment in
`<TypeIdHasher as Hasher>::write` specific to web (wasm32) debug
builds.

The updated `anymap` fork drops its custom `Any` in favor of the
standard library's `std::any::Any`.
@thlsrms
Improve Rust SDK websocket message handling on wasm32
6d273cd
@thlsrms
Add cookie API and re-export gloo storage wrappers for the web SDK
0db89fa
@thlsrms
Remove some redundancies from wasm32 rust sdk
4dc0f71
@thlsrms
Add web feature flag to the rust sdk
7bfb2ab
@thlsrms
Add token verification for the wasm sdk websocket connection
1dbeba3
@thlsrms
Rename misleading run_threaded to run_background on wasm32
4d35a85 
Renamed the `run_threaded` method on `wasm32` to better reflect its
behavior of spawning a background task.

The generated `DbConnection` methods `run_threaded`, `run_background`,
and `advance_one_message_blocking` now include runtime panics with a
clear error feedback when called on unsupported targets.
@thlsrms
Reduce cfg noise by simplifying mutex handling in the sdk crate
87a1ee7 
Trim down repetitive `cfg` clauses by extracting common lock patterns
into `get_lock_[sync|async]`.
@thlsrms
Remove tokio dependency from the rust web sdk
b2da4a2
@thlsrms
Improve error handling for the wasm sdk's Cookie builder
89b9d9d
@thlsrms thlsrms marked this pull request as ready for review May 28, 2025 21:29
@thlsrms
Copy link
Author

thlsrms commented May 28, 2025

@bfops When you're available, feel free to assign a reviewer. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@thlsrms @CLAassistant @bfops